Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help message of jj edit, add FAQ on idiomatic change switching #3250

Merged
merged 2 commits into from
Mar 14, 2024
Merged

Update help message of jj edit, add FAQ on idiomatic change switching #3250

merged 2 commits into from
Mar 14, 2024

Conversation

khionu
Copy link
Contributor

@khionu khionu commented Mar 7, 2024

This change updates the language of jj edit's help message to be more clear as to the nature of the command. It also adds a recommendation for a more idiomatic/safer workflow. This recommendation is also elaborated in a new FAQ entry.

Checklist

If applicable:

  • I have updated CHANGELOG.md
  • I have updated the documentation (README.md, docs/, demos/)
  • I have updated the config schema (cli/src/config-schema.json)
  • I have added tests to cover my changes

Copy link
Contributor

@PhilipMetzger PhilipMetzger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This almost looks great to me but I still have some minor nits.

cli/src/commands/edit.rs Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
@khionu khionu requested a review from PhilipMetzger March 8, 2024 00:50
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
cli/src/commands/edit.rs Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
This change updates the language of `jj edit`'s help message to be
more clear as to the nature of the command. It also adds a 
recommendation for a more idiomatic/safer workflow.
@khionu khionu requested a review from martinvonz March 10, 2024 05:29
Copy link
Member

@martinvonz martinvonz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the delay. It was hoping to hear from others, and then I forgot about the PR.

cli/src/commands/edit.rs Outdated Show resolved Hide resolved
docs/FAQ.md Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated Show resolved Hide resolved
@khionu
Copy link
Contributor Author

khionu commented Mar 14, 2024

Idk if I would be able to hit merge with the approval or not, but it looks like @PhilipMetzger's request for changes is still active? I'm good for this to merge.

Copy link
Contributor

@PhilipMetzger PhilipMetzger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG

@khionu
Copy link
Contributor Author

khionu commented Mar 14, 2024

Yeah, looks like I can't be the one to merge even now. Whenever you're good, feel free!

@martinvonz
Copy link
Member

Yeah, looks like I can't be the one to merge even now. Whenever you're good, feel free!

You should have permission now :)

@khionu khionu merged commit 3bbc3e5 into jj-vcs:main Mar 14, 2024
16 checks passed
@khionu
Copy link
Contributor Author

khionu commented Mar 14, 2024

Sweet, thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants